Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: switch back to Sphinx html builder #267

Merged
merged 1 commit into from
May 20, 2024
Merged

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented May 20, 2024

Partially reverts #245 by switching back from the Sphinx dirhtml to html (see ComPWA/policy#158). This again results in URLs like https://qrules.rtfd.io/usage.html, but avoid other DX problems, like ComPWA/policy#335 and bad page navigation when opening the files locally.

Tip

It is best to link to pages with e.g. https://qrules.rtfd.io/usage/ (note the final /) instead of https://qrules.rtfd.io/usage or https://qrules.rtfd.io/usage.html. This will correctly redirect to the usage page, whether it uses the dirhtml builder or html builder.

@redeboer redeboer added 📝 Docs Improvements or additions to documentation ⚠️ Interface Breaking changes to the API labels May 20, 2024
@redeboer redeboer added this to the 0.10.2 milestone May 20, 2024
@redeboer redeboer self-assigned this May 20, 2024
@redeboer redeboer changed the title BREAK: switch back to Sphinx html builder DOC: switch back to Sphinx html builder May 20, 2024
@redeboer redeboer merged commit e8a55ac into ComPWA:main May 20, 2024
31 checks passed
@redeboer redeboer deleted the no-dirhtml branch May 20, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation ⚠️ Interface Breaking changes to the API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant